feat(metrics): Add BeforeEmitMetrics callback #3799
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add classes for Set, Gauge, and Distribution.
Add LocalMetricsAggregator, which is the foundation for correlating metrics to spans.
# Conflicts: # Sources/Swift/Metrics/LocalMetricsAggregator.swift
# Conflicts: # Sources/Swift/Metrics/LocalMetricsAggregator.swift # Tests/SentryTests/Swift/Metrics/LocalMetricsAggregatorTests.swift
The MetricsAPI for adding a set should accept a string, which gets converted to a CRC32 hash instead of an integer.
For the set metric, the SDK casts the value back and forth from UInt to Double, which doesn't work correctly with large UInt numbers as Double can't represent them accurately. This is fixed now by only using UInt for set metrics.
The MetricsAPI for adding a set should accept a string, which gets converted to a CRC32 hash instead of an integer.
# Conflicts: # Sources/Swift/Metrics/BucketsMetricsAggregator.swift # Sources/Swift/Metrics/SentryMetricsAPI.swift # Sources/Swift/Metrics/SetMetric.swift # Tests/SentryTests/Swift/Metrics/SetMetricTests.swift
# Conflicts: # Sources/Swift/Metrics/BucketsMetricsAggregator.swift # Sources/Swift/Metrics/SentryMetricsAPI.swift # Sources/Swift/Metrics/SetMetric.swift # Tests/SentryTests/Swift/Metrics/BucketMetricsAggregatorTests.swift # Tests/SentryTests/Swift/Metrics/SetMetricTests.swift
Add the BeforeEmitMetrics to the options, as described in develop docs https://develop.sentry.dev/sdk/metrics/#hooks.
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3799 +/- ##
=============================================
+ Coverage 89.507% 89.568% +0.061%
=============================================
Files 560 560
Lines 60739 60807 +68
Branches 21837 21866 +29
=============================================
+ Hits 54366 54464 +98
+ Misses 5446 5417 -29
+ Partials 927 926 -1
... and 15 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
Performance metrics 🚀
|
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 2a894d5 | 1211.02 ms | 1236.72 ms | 25.70 ms |
| c471221 | 1244.57 ms | 1257.94 ms | 13.37 ms |
| 6e1452d | 1241.69 ms | 1253.47 ms | 11.78 ms |
| 16450b8 | 1196.33 ms | 1217.26 ms | 20.93 ms |
| c0b4b71 | 1218.16 ms | 1251.28 ms | 33.12 ms |
| 7fb7afb | 1235.00 ms | 1256.81 ms | 21.81 ms |
| e681215 | 6240.94 ms | 6254.36 ms | 13.42 ms |
| 60d6cec | 1257.14 ms | 1273.92 ms | 16.78 ms |
| c00eafe | 1253.04 ms | 1256.41 ms | 3.37 ms |
| c6773e5 | 1222.48 ms | 1240.02 ms | 17.54 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 2a894d5 | 21.58 KiB | 414.57 KiB | 392.99 KiB |
| c471221 | 22.85 KiB | 413.89 KiB | 391.04 KiB |
| 6e1452d | 21.58 KiB | 419.68 KiB | 398.10 KiB |
| 16450b8 | 22.85 KiB | 410.98 KiB | 388.13 KiB |
| c0b4b71 | 20.76 KiB | 430.98 KiB | 410.22 KiB |
| 7fb7afb | 20.76 KiB | 419.69 KiB | 398.94 KiB |
| e681215 | 20.76 KiB | 431.91 KiB | 411.15 KiB |
| 60d6cec | 22.84 KiB | 403.51 KiB | 380.67 KiB |
| c00eafe | 20.76 KiB | 432.88 KiB | 412.12 KiB |
| c6773e5 | 20.76 KiB | 435.25 KiB | 414.49 KiB |
Previous results on branch: feat/metrics-before-emit-metrics
Startup times
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 734807e | 1201.16 ms | 1215.06 ms | 13.90 ms |
| 27ff265 | 1236.67 ms | 1250.98 ms | 14.31 ms |
App size
| Revision | Plain | With Sentry | Diff |
|---|---|---|---|
| 734807e | 21.58 KiB | 573.19 KiB | 551.61 KiB |
| 27ff265 | 21.58 KiB | 573.17 KiB | 551.59 KiB |
brustolin
approved these changes
Mar 27, 2024
# Conflicts: # Sources/Swift/Metrics/BucketsMetricsAggregator.swift
threema-matteo
pushed a commit
to threema-ch/sentry-cocoa
that referenced
this pull request
May 21, 2024
Add the BeforeEmitMetrics to the options, as described in develop docs https://develop.sentry.dev/sdk/metrics/#hooks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📜 Description
Add the BeforeEmitMetrics to the options, as described in develop docs https://develop.sentry.dev/sdk/metrics/#hooks.
💡 Motivation and Context
So users can discard metrics if they want to.
💚 How did you test it?
Unit tests.
📝 Checklist
You have to check all boxes before merging:
sendDefaultPIIis enabled.🔮 Next steps